/*
 * Copyright 2007-2008 Brian Cavalier
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.bc.iterate.view;

import java.util.regex.MatchResult;

/**
 * MatchResultView is a simple {@link View} around {@link java.util.regex.MatchResult} to make it work
 * as an iterator.
 * 
 * @author Brian Cavalier
 * @see java.util.Iterator
 * @see Iterable
 * @see org.bc.iterate.Iterate
 * @see java.util.regex.MatchResult
 */
public class MatchResultView extends AbstractView<String> {
	private MatchResult matches;
	private int index;
	
	public MatchResultView(MatchResult m) {
		matches = m;
		index = (matches.groupCount() > 0) ? 1 : 0;
	}

	public boolean hasNext() {
		return (index <= matches.groupCount());
	}
	
	@SuppressWarnings({"IteratorNextCanNotThrowNoSuchElementException"})
    public String next() {
		return matches.group(index++);
	}
}